Flow Message

Flows messages contain a call-to-action button that users can tap. Tapping the button displays your custom Flow.

Parameters:

Parameter	Description
Interactive(object)	The interactive message configuration.
interactive type(required)	Value must be "flow".
interactive action	Refer the table below.

Parameter	Description
name(required, type - String)	Value must be "flow".
parameters(type - object)
mode	The Flow can be in either draft or published mode (Default value: published).
flow_message_version	Value must be "3".
flow_id	Unique ID of the Flow.
flow_cta	Text on the CTA button. For example: "Signup". Character limit - 20 characters (no emoji).
flow_action	navigate or data_exchange.

Payload

{
    "messages": [
        {
            "sender": "9180XXXXXX",
            "to": "9199XXXXXX",
            "messageId": "",
            "transactionId": "",
            "callbackDlrUrl": "",
            "channel": "wa",
            "type": "interactive",
            "interactive": {
                "type": "flow",
                "header": {
                    "type": "text",
                    "text": "hello there"
                },
                "body": {
                    "text": "abcd"
                },
                "footer": {
                    "text": ""
                },
                "action": {
                    "name": "flow",
                    "parameters": {
                        "flow_message_version": "3",
                        "flow_action": "data_exchange",
                        "flow_id": "1",
                        "flow_cta": "Book!",
                        "mode": "draft",
                        "flow_action_payload": ""
                    }
                }
            }
        }
    ],
    "responseType": "json"
}

Note : Calback URL is a optional paramter . Please use when you want to change the default URL(configured through smartta). It will only chnage the domain name othere paratemters will be same as configurated in smartta.